Skip to main content
POST
/
metric
/
campaign
Get a campaign metric
curl --request POST \
  --url https://your_a2_service/metric/campaign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "from_datetime": "2023-11-07T05:31:56Z",
  "to_datetime": "2023-11-07T05:31:56Z"
}'
[
  {
    "ad_revenue": 123,
    "budget_spent": 0,
    "cid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "click": 0,
    "conversion": 0,
    "cpa": 0,
    "cpc": 0,
    "cpm": 0,
    "finished": 123,
    "id": 123,
    "impression": 0,
    "reach": 0,
    "roas": 0,
    "tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Query for campaign metric.

​
campaign_id
string<uuid>
required
​
from_datetime
string<date-time> | null
​
to_datetime
string<date-time> | null

Response

Successful Response

​
ad_revenue
number
required

Ad revenue

​
cid
string<uuid>
required

The campaign ID

​
finished
integer
required

Indicates whether the campaign has ended. 0 = No, 1 = Yes

​
id
integer
required
​
tagid
string<uuid>
required

The placement ID

​
budget_spent
number
default:0

Budget spent

​
click
integer
default:0

Click

​
conversion
integer
default:0

Conversion

​
cpa
number
default:0

Cost Per Action

​
cpc
number
default:0

Cost Per Click

​
cpm
number
default:0

Cost Per Mille

​
impression
integer
default:0

Impression

​
reach
integer
default:0

Reach

​
roas
number
default:0

Return on Ad Spend